Skip to content

docs: fixes distributed executor backend config for multi-node vllm #29173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fixes distributed executor backend config for multi-node vllm #29173

wants to merge 1 commit into from
+4 −2

Conversation

@michaelact
Copy link

@michaelact michaelact commented Nov 21, 2025 •
edited by github-actions bot
Loading

Added distributed executor backend option to commands.

Purpose

Test Plan

I followed the docs, and facing an issue, which are discussed here: https://discuss.ray.io/t/vllm-will-report-gpu-missing-on-the-hosting-node-in-ray/21657

Test Result

Fixes the multi-node VLLM deployment issue.

Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

@michaelact
fix: misleading distributed executor backend config
1dadd23 
Added distributed executor backend option to commands.

Signed-off-by: Michael Act <[email protected]>
@mergify
Copy link

mergify bot commented Nov 21, 2025

Documentation preview: https://vllm--29173.org.readthedocs.build/en/29173/

@mergify mergify bot added the documentation Improvements or additions to documentation label Nov 21, 2025
gemini-code-assist[bot]
gemini-code-assist bot reviewed Nov 21, 2025
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly updates the documentation for multi-node vLLM deployments by adding the --distributed-executor-backend ray flag to the example commands. This is a crucial addition, as without it, users following the documentation for multi-node setups on Ray would likely encounter errors. The change is accurate and significantly improves the usability of the documentation for this important feature. The changes look good and address a key usability issue for multi-node deployments.

@mgoin
Copy link
Member

mgoin commented Nov 22, 2025

The docs failures look related PTAL

WARNING -  mkdocs_autorefs: api/vllm/index.md: from /home/docs/checkouts/readthedocs.org/user_builds/vllm/checkouts/29173/vllm/inputs/data.py:198: (vllm.PromptType) Could not find cross-reference target 'str'
WARNING -  mkdocs_autorefs: api/vllm/index.md: from /home/docs/checkouts/readthedocs.org/user_builds/vllm/checkouts/29173/vllm/entrypoints/llm.py:547: (vllm.LLM.collective_rpc) Could not find cross-reference target 'TimeoutError'
WARNING -  mkdocs_autorefs: api/vllm/entrypoints/llm.md: from /home/docs/checkouts/readthedocs.org/user_builds/vllm/checkouts/29173/vllm/entrypoints/llm.py:547: (vllm.entrypoints.llm.LLM.collective_rpc) Could not find cross-reference target 'TimeoutError'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@michaelact @mgoin